Vcenter VM ClonePlacementSpec
The Vcenter VM ClonePlacementSpec schema contains information used to place a clone of a virtual machine onto resources within the vCenter inventory.
This schema was added in vSphere API 7.0.0.0.
{
"folder": "string",
"resource_pool": "string",
"host": "string",
"cluster": "string",
"datastore": "string"
}Virtual machine folder into which the cloned virtual machine should be placed.
This property was added in vSphere API 7.0.0.0.
If property is missing or null, the system will use the virtual machine folder of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.
Resource pool into which the cloned virtual machine should be placed.
This property was added in vSphere API 7.0.0.0.
If property is missing or null, the system will use the resource pool of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.
Host onto which the cloned virtual machine should be placed.
If host and resource_pool are both specified, resource_pool must belong to host.
If host and cluster are both specified, host must be a member of cluster.
This property was added in vSphere API 7.0.0.0.
If this property is unset, if resource_pool is unset, the cloned virtual machine will use the host of the source virtual machine. if resource_pool is set, and the target is a standalone host, the host is used. if resource_pool is set, and the target is a DRS cluster, a host will be picked by DRS. if resource_pool is set, and the target is a cluster without DRS, InvalidArgument will be thrown.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.
Cluster into which the cloned virtual machine should be placed.
If cluster and resource_pool are both specified, resource_pool must belong to cluster.
If cluster and host are both specified, host must be a member of cluster.
This property was added in vSphere API 7.0.0.0.
If resource_pool or host is specified, it is recommended that this property be missing or null.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.
Datastore on which the cloned virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine clone operation unless individually overridden.
This property was added in vSphere API 7.0.0.0.
If property is missing or null, the system will use the datastore of the source virtual machine.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Datastore. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Datastore.